process-on-spawn

process-on-spawn

Execute callbacks when child processes are spawned.

Usage

'use strict';

const processOnSpawn = require('process-on-spawn');
processOnSpawn.addListener(opts => {
  opts.env.CHILD_VARIABLE = 'value';
});

listener(opts)

• options <Object>
  • execPath <string> The command to run.
  • args <string[]> Arguments of the child process.
  • cwd <string> Current working directory of the child process.
  • detached <boolean> The child will be prepared to run independently of its parent process.
  • uid <number> The user identity to be used by the child.
  • gid <number> The group identity to be used by the child.
  • windowsVerbatimArguments <boolean> No quoting or escaping of arguments will be done on Windows.
  • windowsHide <boolean> The subprocess console window that would normally be created on Windows systems will be hidden.

All properties except env are read-only.

processOnSpawn.addListener(listener)

Add a listener to be called after any listeners already attached.

processOnSpawn.prependListener(listener)

Insert a listener to be called before any listeners already attached.

processOnSpawn.removeListener(listener)

Remove the specified listener. If the listener was added multiple times only the first is removed.

processOnSpawn.removeAllListeners()

Remove all attached listeners.

Changelog

1.1.0 (2024-11-13)

Features

• add types (#12) (821d4f4)